Balance (2.39)

Download OpenAPI specification:Download

The Balance API provides developers a way to query and update items related to customer balance-related items, including disputes, invoices, and charging E-Pay accounts.

System Integrity

Resources related to system integrity.

Health Check

Use to check whether or not the Balance service is up and running.

Authorizations:

SWT

Responses

Account Transaction

Search Account Transaction Summary By Invoice Category

Provides the ability to search for account transaction details broken out by invoice category. [Rev 2.07]

Filterable : description, dueDate, invoiceCategory, transactionDate
Sortable: description, dueDate, invoiceCategory, transactionDate

Authorizations:

SWT

path Parameters

accountTransactionID

required

number

Example: 1

Unique identifier of the account transaction to retrieve summary by invoice category for.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

Content-Type

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"amount": 10,
"description": "payment",
"dueDate": "2016-09-09T17:35:09.156Z",
"invoiceCategory": "main",
"invoiceNumber": 1234,
"openAmount": 5,
"transactionDate": "2016-09-09T17:35:09.156Z"
}
]
}

Common Data

Account Balance By Invoice Category

Provides the ability to search account balances for a customer, grouped by invoice category and arrears buckets, as of a specific date. [Rev 2.07]

Note

The system supports up to five arrears buckets. If fewer than five buckets are configured, the remaining values will be zero. Balances that fall outside of the first five arrears buckets will appear in the overflowBalance bucket, if more than five arrears buckets are configured. [Rev 2.08]

AvailableFields

Filterable: currentBalance, invoiceCategory, invoiceCategoryID, totalBalance
Sortable: currentBalance, invoiceCategory, invoiceCategoryID, totalBalance

Authorizations:

SWT

path Parameters

customerID

required

number

Example: 1

Unique identifier of the customer to retrieve balances for.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

asOfDate

string

Specifies the date in time to summarize the account balances as of.

Note: defaults to the current date when not specified.

Responses

Request samples

Payload

Content type

application/json

{"asOfDate": "2009-03-16T14:50:06.947Z"
}

Response samples

200
404

Content type

application/json

{"@odata.count": 5,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"arrearsBalance1": 2,
"arrearsBalance2": 0,
"arrearsBalance3": 0,
"arrearsBalance4": 0,
"arrearsBalance5": 0,
"overflowBalance": 0,
"currentBalance": 3,
"invoiceCategory": "Main",
"invoiceCategoryID": 1,
"totalBalance": 5
}
]
}

Search Open Balance

Provides the ability to search for open balances for a customer. [Rev 2.07]

Authorizations:

SWT

path Parameters

customerID

required

number

Example: 1

Unique identifier of the customer to retrieve disputes for.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

Content-Type

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"accountID": 2,
"amount": -5,
"customerAcctNumber": "GEN000006754",
"customerID": 2100,
"invoiceCategory": "Main",
"invoiceCategoryID": 1,
"invoiceNumber": 858128,
"itemDescription": "Adjustment DEBIT",
"transactionDate": "2009-03-16T10:50:06.947-04:00"
}
]
}

Get Paperless Billing Status

Provides the ability to get the status of Paperless Billing based on customer. [Rev 2.18]

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier of the customer to retrieve paperless bill status for.

Responses

Response samples

200
404

Content type

application/json

{"autoPayConfigured": true,
"eligible": true,
"incentiveAmount": null,
"incentiveType": "Credit",
"isAccountTypeOmitted": false,
"paperlessBillConfigured": true,
"reason": "Sample reason",
"requiresAutoPay": true
}

Search Dispute Resolution

Provides the ability to search all the dispute resolutions in the system. [Rev 1.04]

Available Fields

The following is a list of fields from dispute resolution and how they can be used within the search.

Filterable : description, disputeResoutionID
Sortable : description, disputeResoutionID

Authorizations:

SWT

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"value": [{"description": "Approved",
"disputeResolutionID": 1
}
]
}

Customer Dispute

Search Disputes

Provides the ability to search for dispute information for a customer. [Rev 1.04]

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier of the customer to retrieve disputes for.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

Content-Type

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"adjustmentAmount": -9.99,
"adjustmentID": 1002,
"amount": 9.99,
"billPeriodID": 21180214,
"closeDate": "2016-09-09T17:35:09.156Z",
"description": "Customer is disputing invoice charge.",
"disputeID": 10003,
"disputeDate": "2016-09-09T17:35:09.156Z",
"feature": "MONTHLY FEE",
"featureID": 103254,
"invoiceCategoryid": 12,
"invoiceNumber": 1003324,
"lastModifiedDate": "2016-09-09T17:35:09.156Z",
"lastModifiedUser": "Kesha",
"resolution": "Approved",
"resolutionID": 303,
"reversalAdjustmentID": 1004,
"reversalFeeAdjustmentID": 10044,
"serviceID": 10430092,
"serviceNumber": 1234567890,
"usageBatchID": 99602,
"usageRecordNumber": 413
}
]
}

Create Dispute

Creates a dispute for a feature or usage charge. [Rev 1.04]

Note

The amount must not exceed the value of the charge being disputed.
The charge being disputed must not already have an open dispute.
The charge being disputed must not have a closed disputed which has been adjusted (and not reversed).
The charge being disputed must not have been credited.
Either featureID or usageRecordID is required.

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier of the customer for which to create this dispute.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

amount required	number The amount being disputed.
description required	string The description of the dispute.
featureID	number Unique idenfitier for the feature on the invoice being disputed.
featureIsInAdvanceCharge	boolean Indicates if the dispute is for an in advance charge. [Rev 1.09] Note This value will default to false if not provided. If `featureIsInAdvanceCharge` is included with a `usageRecordID`, the value of `featureIsInAdvanceCharge` will be ignored.
invoiceNumber required	number Invoice number containing the charge being disputed.
resolutionID	number Unique identifier for the dispute resolution.
usageRecordID	number Unique identifier for the usage record on the invoice being disputed.

Responses

Request samples

Payload

Content type

application/json

{"amount": 4.95,
"description": "The customer says they shouldn't have been charged",
"featureID": 10986,
"featureIsInAdvanceCharge": true,
"invoiceNumber": 1984950,
"resolutionID": 1,
"usageRecordID": 465320
}

Response samples

500

Content type

application/json

{"errors": [{"correlationId": "8c041095",
"field": "exampleField",
"loggingNumber": 500032,
"message": "You do not have access to foo ID 1 or it does not exist."
}
]
}

Update Dispute

Provides the ability to update a dispute for a customer. [Rev 1.04]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) <a href="https://tools.ietf.org/html/rfc6902\" target="blank">here.

Note

The dispute must not be closed.

Patchable Fields

The following is a list of properties that can be patched.

amount : replace
description : replace
resolutionID : add, remove, replace

Authorizations:

SWT

path Parameters

id required	number Example: 1 ID of the customer.
disputeID required	number Example: 1 ID of the dispute to update.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

Array

op required	string Indicates what type of JSON Patch operation being requested. Valid values are `add`, `replace`, and `remove`.
path required	string Path within the JSON document that should be modified.
value	string If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Payload

Content type

application/json

[{"op": "replace",
"path": "/amount",
"value": 1.25
}
]

Response samples

404

Content type

application/json

{"errors": [{"correlationId": "8c041095",
"field": "exampleField",
"loggingNumber": 500032,
"message": "You do not have access to foo ID 1 or it does not exist."
}
]
}

Add a Reversal Fee to a Dispute

Provides the ability to add a reversal fee for a dispute. [Rev 1.04]

Note

The dispute must be open, adjusted, reversed, and NOT have an existing reversal fee.
adjustmentTypeID must be for a NON-"charge" adjustment type.
amount cannot be 0.

Authorizations:

SWT

path Parameters

id required	number Example: 1 Unique identifier for the customer.
disputeId required	number Example: 1 Unique identifier for the dispute to adjust.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

adjustmentReasonID	number Unique identifier for the reversal fee adjustment reason.
adjustmentTypeID required	number Unique identifier for the reversal fee adjustment type.
amount required	number The amount of the reversal fee.
blockPosting	boolean Whether or not to block posting for this reversal fee adjustment.
description	string The description of the reversal fee.

Responses

Request samples

Payload

Content type

application/json

{"adjustmentReasonID": 1950,
"adjustmentTypeID": 121,
"amount": 6.33,
"blockPosting": false,
"description": "This is an reversal fee for the dispute"
}

Response samples

200
400
404

Content type

application/json

{"adjustmentAmount": -9.99,
"adjustmentID": 1002,
"amount": 9.99,
"billPeriodID": 21180214,
"closeDate": "2016-09-09T17:35:09.156Z",
"description": "Customer is disputing invoice charge.",
"disputeID": 10003,
"disputeDate": "2016-09-09T17:35:09.156Z",
"feature": "MONTHLY FEE",
"featureID": 103254,
"invoiceCategoryid": 12,
"invoiceNumber": 1003324,
"lastModifiedDate": "2016-09-09T17:35:09.156Z",
"lastModifiedUser": "Kesha",
"resolution": "Approved",
"resolutionID": 303,
"reversalAdjustmentID": 1004,
"reversalFeeAdjustmentID": 10044,
"serviceID": 10430092,
"serviceNumber": 1234567890,
"usageBatchID": 99602,
"usageRecordNumber": 413
}

Adjust an Adjustment to a Dispute

Provides the ability to create an adjustment for a dispute. [Rev 1.04]

Note

The dispute must be open and not already adjusted.
If the dispute amount is negative, the specified adjustmentTypeID must be for a "charge" adjustment type. Otherwise, it must be for a NON-"charge" adjustment type.
amount must be greater than 0 and less than or equal to the absolute value of the dispute amount.

Authorizations:

SWT

path Parameters

id required	number Example: 1 Unique identifier for the customer.
disputeId required	number Example: 1 Unique identifier for the dispute to adjust.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

adjustmentReasonID	number Unique identifier for the adjustment reason.
adjustmentTypeID required	number Unique identifier for the adjustment type.
amount required	number The amount of the adjustment.
blockPosting	boolean Whether or not to block posting for this adjustment.
description	string The description of the adjustment.

Responses

Request samples

Payload

Content type

application/json

{"adjustmentReasonID": 1950,
"adjustmentTypeID": 121,
"amount": 6.33,
"blockPosting": false,
"description": "This is an adjustment for the dispute"
}

Response samples

200
400
404

Content type

application/json

{"adjustmentAmount": -9.99,
"adjustmentID": 1002,
"amount": 9.99,
"billPeriodID": 21180214,
"closeDate": "2016-09-09T17:35:09.156Z",
"description": "Customer is disputing invoice charge.",
"disputeID": 10003,
"disputeDate": "2016-09-09T17:35:09.156Z",
"feature": "MONTHLY FEE",
"featureID": 103254,
"invoiceCategoryid": 12,
"invoiceNumber": 1003324,
"lastModifiedDate": "2016-09-09T17:35:09.156Z",
"lastModifiedUser": "Kesha",
"resolution": "Approved",
"resolutionID": 303,
"reversalAdjustmentID": 1004,
"reversalFeeAdjustmentID": 10044,
"serviceID": 10430092,
"serviceNumber": 1234567890,
"usageBatchID": 99602,
"usageRecordNumber": 413
}

Close a Dispute

Provides the ability to close a dispute. [Rev 1.04]

Note

The dispute must not already be closed.

Authorizations:

SWT

path Parameters

id required	number Example: 1 ID of the customer.
disputeId required	number Example: 1 ID of the dispute to close.

header Parameters

Content-Type

required

string

Example: application/json

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"field": "Customer",
"loggingNumber": 500002,
"message": "Value for argument 'CustomerID' is not valid: 'abc'."
}
]
}

Reopen a Dispute

Provides the ability to reopen a dispute. [Rev 1.04]

Note

The dispute must not already be open.
The dispute resolution will be cleared when the dispute is reopened.

Authorizations:

SWT

path Parameters

id required	number Example: 1 ID of the customer.
disputeId required	number Example: 1 ID of the dispute to reopen.

header Parameters

Content-Type

required

string

Example: application/json

Responses

Response samples

400
404

Content type

application/json

{"errors": [{"field": "Customer",
"loggingNumber": 500002,
"message": "Value for argument 'CustomerID' is not valid: 'abc'."
}
]
}

Add a Reversal to a Dispute

Provides the ability to add a reversal for a dispute. [Rev 1.04]

Note

The dispute must be open, adjusted, and NOT have an existing reversal.

Authorizations:

SWT

path Parameters

id required	number Example: 1 Unique identifier for the customer.
disputeId required	number Example: 1 Unique identifier for the dispute to reverse.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

adjustmentReasonID

number

Unique identifier for the reversal adjustment reason.

Responses

Request samples

Payload

Content type

application/json

{"adjustmentReasonID": 1950
}

Response samples

200
400
404

Content type

application/json

{"adjustmentAmount": -9.99,
"adjustmentID": 1002,
"amount": 9.99,
"billPeriodID": 21180214,
"closeDate": "2016-09-09T17:35:09.156Z",
"description": "Customer is disputing invoice charge.",
"disputeID": 10003,
"disputeDate": "2016-09-09T17:35:09.156Z",
"feature": "MONTHLY FEE",
"featureID": 103254,
"invoiceCategoryid": 12,
"invoiceNumber": 1003324,
"lastModifiedDate": "2016-09-09T17:35:09.156Z",
"lastModifiedUser": "Kesha",
"resolution": "Approved",
"resolutionID": 303,
"reversalAdjustmentID": 1004,
"reversalFeeAdjustmentID": 10044,
"serviceID": 10430092,
"serviceNumber": 1234567890,
"usageBatchID": 99602,
"usageRecordNumber": 413
}

Search Dispute Summaries

Provides the ability to search dispute for summary information for a customer. [Rev 1.04]

Available Fields

The following is a list of fields from dispute summary and how they can be used within the search.

Filterable : closedDisputeAmount, closedDisputeCount, collectionAgency, invoiceDate, invoiceNumber, openDisputeAmount, openDisputeCount
Sortable : closdeDisputeAmount, closedDisputeCount, collectionAgency, invoiceDate, invoiceNumber, openDisputeAmount, openDisputeCount

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Id of Customer to retrieve dispute summaries for.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

Content-Type

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"closedDisputeAmount": 1.25,
"closedDisputeCount": 1,
"invoiceDate": "2016-09-09T17:35:09.156Z",
"invoiceNumber": 12345,
"openDisputeAmount": 2.73,
"openDisputeCount": 1
}
]
}

Invoice

Get Service Summary Total By Invoice

Provides the ability to get the service summary total of an invoice. [Rev 2.01]

Authorizations:

SWT

path Parameters

invoiceNumber

required

integer

Example: 1

Unique identifier of the invoice for which account transactions to retrieve.

Responses

Response samples

200
404

Content type

application/json

{"invoiceGroupID": 11090401,
"invoiceServiceTaxDetailAvailable": true,
"totalServiceCharges": 20.5,
"totalServiceChargesWithoutTaxes": 15.5,
"usageExcluded": false,
"totalNewCharges": 117.61,
"totalAccountCharges": 110.02,
"totalAccountChargesWithAllTaxesIncluded": 117.61
}

Search For Invoices

Provides the ability to search for invoices. [Rev 1.03]

Available Fields

The following is a list of fields from collection history and how they can be used within the search.

Filterable : accountNumber, amountOfPreviousInvoice, alternateInvoiceNumber, billPeriodID, corporateRollupOffset, customerID, customerName, invoiceDate, invoiceDueDate, invoiceNumber, invoiceResponsible, isNIRRollUp, myTotalAmountDue, myTotalNewCharge, totalAmountDue, totalNewCharge, usgFileCreated
Sortable : accountNumber, amountOfPreviousInvoice, alternateInvoiceNumber, billPeriodID, corporateRollupOffset, customerID, customerName, invoiceDate, invoiceDueDate, invoiceNumber, invoiceResponsible, isNIRRollUp, myTotalAmountDue, myTotalNewCharge, totalAmountDue, totalNewCharge, usgFileCreated

Authorizations:

SWT

query Parameters

id required	number Example: id=1 Unique identifier of the customer for which to retrieve invoices.
$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"alternateInvoiceNumber": 2352666,
"amountOfPreviousInvoice": 0,
"billPeriodID": 11140601,
"corporateRollupOffset": 0,
"customerID": 20553,
"accountNumber": 20553,
"customerName": "ABC Customer",
"invoiceDate": "2014-05-22T04:00:00.000Z",
"invoiceDueDate": "2014-06-15T04:00:00.000Z",
"invoiceNumber": 2352666,
"invoiceResponsible": false,
"isNIRRollUp": false,
"myTotalAmountDue": 0,
"myTotalNewCharge": 0,
"totalAmountDue": 0,
"totalNewCharge": 0,
"usgFileCreated": false
}
]
}

Search For Account Transactions By Invoice

Provides the ability to search for account transactions that pay for an invoice. [Rev 1.19]

Available Fields

The following is a list of fields from account transactions and how they can be used within the search.

Filterable : epayTransactionID, epayAccountID, remittanceTypeID
Sortable : epayTransactionID, epayAccountID, remittanceTypeID

Authorizations:

SWT

path Parameters

invoiceNumber

required

integer

Example: 1

Unique identifier of the invoice for which account transactions to retrieve.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

Content-Type

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"amount": 0.01,
"customerID": 36605,
"customerAccountNumber": "123456",
"customerName": "Joe",
"epayAccountID": 12044,
"epayTransactionID": 1,
"originatingTransactionID": "11111111111111111",
"remittanceTypeID": 1,
"remittanceType": "Credit Card"
}
]
}

Search For Corporate Account Invoices

Provides the ability to search for invoice information for a corporate account hierarchy. [Rev 1.09]

Available Fields

The following is a list of fields from corporate account invoices and how they can be used within the search.

Filterable : corporateAccountLevel, customerID, invoiceNumber, invoiceResponsible, invoiceResponsibleAncestorID, parentID, rootID
Sortable : corporateAccountLevel, customerID, invoiceNumber, invoiceResponsible, invoiceResponsibleAncestorID, parentID, rootID

path Parameters

billPeriodID required	number Example: 1 Unique identifier for the bill period for which to retrieve invoices.
customerID required	number Example: 1 Unique identifier of the customer whose corporate account tree invoices will be retrieved.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$inlinecount	string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 0,
"value": [{"accountNumber": 1950,
"corporateAccountLevel": 2,
"corporateCharge": 251.42,
"customerID": 20553,
"customerName": "ABC Customer",
"invoiceNumber": 2352666,
"invoiceResponsible": false,
"invoiceResponsibleAncestorID": false,
"myTotalCharge": 0,
"myTotalChargeExclusive": 0,
"parentID": 92,
"rootID": false,
"totalAdjustments": 0,
"totalAmountDue": 0,
"totalChargeAdjustments": 0,
"totalCreditAdjustments": 0,
"totalNewCharge": 0
}
],
"@odata.nextLink": "https://api.idibilling.com/balance/{environment}/api/odataquery?$filter=field1 eq 1"
}

Search For Invoice Service Summary Charges

Provides the ability to search for service-level charge summaries per service for an invoice. [Rev 2.01]

Available Fields

The following is a list of fields from invoice service summary charges and how they can be used within the search.

Filterable : serviceID, serviceNumber, serviceType
Sortable : serviceID, serviceNumber, serviceType

path Parameters

invoiceNumber

required

number

Example: 1

Unique identifier for the invoice for which service summaries to retrieve.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$inlinecount	string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

200
404

Content type

application/json

{"value": [{"contractPenaltyCharges": 5,
"discounts": 10,
"installmentPlanCharges": 5,
"nonRecurringCharges": 20,
"serviceID": 1234,
"serviceNumber": "5555555555",
"serviceType": "Mobile Service",
"recurringCharges": 30,
"taxes": 5,
"totalCharges": 75,
"usageCharges": 0
}
]
}

Search For Invoice Service Summary Charge Compare

Provides the ability to search for a comparison of service-level charges per service for two particular invoices. [Rev 2.01]

Available Fields

The following is a list of fields from invoice service summary charges compare and how they can be used within the search.

Filterable : serviceID, serviceNumber, serviceType
Sortable : serviceID, serviceNumber, serviceType

path Parameters

baseInvoiceNumber required	number Example: 1 Unique identifier for the base invoice for which service summaries to retrieve and compare.
compareInvoiceNumber required	number Example: 1 Unique identifier for the compare to invoice for which service summaries to retrieve and compare.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$inlinecount	string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

200
404

Content type

application/json

{"value": [{"baseInvoiceNumber": 1234,
"compareInvoiceNumber": 4567,
"serviceID": 100,
"serviceNumber": "5555555555",
"serviceType": "Mobile Service",
"baseCharge": {"contractPenaltyCharges": 5,
"discounts": 10,
"installmentPlanCharges": 5,
"nonRecurringCharges": 20,
"recurringCharges": 30,
"taxes": 5,
"totalCharges": 75,
"usageCharges": 0
},
"compareCharge": {"contractPenaltyCharges": 5,
"discounts": 20,
"installmentPlanCharges": 5,
"nonRecurringCharges": 30,
"recurringCharges": 40,
"taxes": 5,
"totalCharges": 65,
"usageCharges": 0
}
}
]
}

Search For Invoice Charges By Invoice Category

Provides the ability to search for invoice charges broken out by invoice category. [Rev 2.07]

Filterable : amount, invoiceCategory, invoiceCategoryID
Sortable: amount, invoiceCategory, invoiceCategoryID

Authorizations:

SWT

path Parameters

invoiceNumber

required

number

Example: 1

Unique identifier of the invoice for which account transactions to retrieve.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

Content-Type

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"amount": 10,
"invoiceCategory": "main",
"invoiceCategoryID": 1,
"openAmount": 0
}
]
}

Search For Invoice Tax Details

Provides the ability to search for invoice tax details. [Rev 2.17]

Filterable : isPerline, isSurcharge, serviceID, serviceNumber, taxID, taxName
Sortable: isPerline, isSurcharge, serviceID, serviceNumber, taxID, taxName

Authorizations:

SWT

path Parameters

invoiceNumber

required

number

Example: 1

Unique identifier of the invoice for which account transactions to retrieve.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

Content-Type

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"isPerline": true,
"isSurcharge": true,
"serviceID": 10430092,
"serviceName": "test",
"serviceNumber": 1234567890,
"serviceType": "Mobile Service",
"taxID": 24626,
"taxAmount": 19.72,
"taxDue": 19.72,
"taxName": "Mobile Service",
"taxRate": 0.15
}

Search For Invoice Charge Summary

Provides the ability to search for invoice charge summary. Note: This API will return both service level and account level charges. [Rev 2.17]

Filterable : serviceID, serviceNumber, serviceName, and, serviceType
Sortable: serviceID, serviceNumber, serviceName, and serviceType

Authorizations:

SWT

path Parameters

invoiceNumber

required

number

Example: 1

Unique identifier of the invoice for which charges to retrieve.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

Content-Type

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"contractPenaltyCharges": 5,
"corporateCharges": 50000,
"discounts": 10,
"financeCharges": 150,
"installmentPlanCharges": 5,
"nonRecurringCharges": 10,
"recurringCharges": 30,
"serviceID": 1234,
"serviceName": "Test Name",
"serviceNumber": "1234567890",
"serviceType": "Mobile Service",
"taxes": 5,
"totalCharges": 65,
"usageCharges": 0
}

Search For Invoice Categories

Provides the ability to search for invoice categories. [Rev 2.07]

Available Fields

Filterable : invoiceCategoryID, invoiceCategory, regulated
Sortable : invoiceCategoryID, invoiceCategory, regulated

Authorizations:

SWT

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"invoiceCategory": "Main",
"invoiceCategoryID": 1,
"regulated": false
}
]
}

Search Invoice Paperless Billing Detail

Provides the ability to search for Invoice Paperless Billing Detail data. [Rev 2.19]

Filterable : InvoicePaperlessBillingDetailID, InvoiceNumber, BillPeriodID, CustomerID, Account Number, Customer Name, LastModifiedDate, AccountTypeID, AccountType, PaperlessBill, AutoPayEnabled, PaperlessBillingStatusID, PaperlessBillingStatus, PaperlessBillingMessageID, PaperlessBillingMessage, SKU, ProductDescription, FeaturelessProgramID
Sortable: InvoicePaperlessBillingDetailID, InvoiceNumber, BillPeriodID, CustomerID, Account Number, Customer Name, LastModifiedDate, AccountTypeID, AccountType, PaperlessBill, AutoPayEnabled, PaperlessBillingStatusID, PaperlessBillingStatus, PaperlessBillingMessageID, PaperlessBillingMessage, SKU, ProductDescription, FeaturelessProgramID

Authorizations:

SWT

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

header Parameters

Content-Type

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": {"accountNumber": "GEN00001",
"accountType": "Residential",
"accountTypeID": 1,
"autoPayEnabled": false,
"billPeriodID": 11090501,
"customerID": 4192,
"customerName": "Generated Customer 00001",
"featurelessBillingProgramID": 54,
"invoiceNumber": 871128,
"invoicePaperlessBillingDetailID": 1,
"lastModifiedDate": "2023-08-09T06:29:36.95+00:00",
"paperlessBill": false,
"paperlessBillingMessage": "Not currently enrolled in Paperless Billing or enrolled in Auto-Pay",
"paperlessBillingMessageID": 7,
"paperlessBillingStatus": "Paperless Billing Discount Not Applicable",
"paperlessBillingStatusID": 4,
"productDescription": "PaperlessBill_Credit",
"SKU": "PaperlessBill_Credit"
}
}

E-Pay Account

Account Lookup

Look up an e-pay account by its token. [Rev. 1.17]

Authorizations:

SWT

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

token

required

string

The unique identifier used to refer to this e-pay account in the payment gateway's system

Note:

See Payment Gateway Account Token section of this article for information on how to construct the token.

Responses

Request samples

Payload

Content type

application/json

{"token": "123|234"
}

Response samples

200

Content type

application/json

{"customerID": 1234,
"epayAccountID": 854
}

Charge Account

Create an E-Pay transaction and charge the account at the payment provider.

Note

The E-Pay account must have a RemittanceType of Bank Account or Credit Card.

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier for the E-Pay account that will be charged.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

Amount required	number Dollar amount of the transaction.
BankProcessingType	string (BankProcessingType) Enum: "PPD" "TEL" "WEB"
OriginatingEpayTransactionID	number Unique identifier of the E-Pay transaction that a credit is to be applied against. Note: This field will be ignored if the TransactionType of the request is not 'Credit'
TransactionDescriptionID	number Unique identifier of a previously configured description for E-Pay transactions.
TransactionSource	string (TransactionSource) Enum: "None" "Client" "Online"
TransactionType required	string (TransactionType) Enum: "Credit" "Debit"

Responses

Request samples

Payload

Content type

application/json

{"Amount": 10.03,
"BankProcessingType": "PPD",
"OriginatingEpayTransactionID": 2,
"TransactionDescriptionID": 4,
"TransactionSource": "None",
"TransactionType": "Credit"
}

Response samples

200
400
500

Content type

application/json

{"amount": 10.03,
"approvalCode": 123,
"approvalDate": "2016-09-09T17:35:09.156Z",
"bankProcessingType": "PPD",
"createDate": "2016-09-09T17:35:09.156Z",
"epayAccountID": 42,
"epayTransactionID": 1,
"errorCode": 12,
"errorMessage": "Transaction was declined.",
"originatingEpayTransactionID": 2,
"originatingProviderTransactionID": "123b45",
"processDate": "2016-09-09T17:35:09.156Z",
"providerAVSResultCode": "777A7",
"providerResultCode": "Accepted",
"providerTransactionID": "123C45",
"transactionDescriptionID": 4,
"transactionSource": "Online",
"transactionStatus": "Sent",
"transactionType": "Credit"
}

Search for E-Pay Accounts.

Provides the ability to search for E-Pay Accounts. [Rev 1.22]

Available Fields

The following is a list of fields from E-Pay Accounts and how they can be used within the search.

Filterable : aBARoutingNumber, bankAccountNumber, bankAccountType, bankAccountTypeID, bankName, bankProcessingType, contactID, creditCardType, creditCardTypeID, customerAccountStatusID, customerAccountTypeID, customerID, endDate, epayAccountID, ePayNotificationOptOut, expirationDate, expirationNotificationRequestedDate, isDeleted, isTerminated, lastModifiedDate, lastModifiedUser, recurringEndDate, recurringStartDate, recurringStatus, remittanceTypeID, startDate.
Sortable : aBARoutingNumber, bankAccountNumber, bankAccountType, bankAccountTypeID, bankName, bankProcessingType, contactID, creditCardType, creditCardTypeID, customerAccountStatusID, customerAccountTypeID, customerID, endDate, epayAccountID, ePayNotificationOptOut, expirationDate, expirationNotificationRequestedDate, isDeleted, isTerminated, lastModifiedDate, lastModifiedUser, recurringEndDate, recurringStartDate, recurringStatus, remittanceTypeID, startDate.

Authorizations:

SWT

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$inlinecount	string Enum: "allpages" "none" Example: $inlinecount=allpages Tells the server to include the total count of matching entities in the response.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

200
400

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"aBARoutingNumber": 251082615,
"bankAccountNumber": 1234,
"bankAccountType": "Checking",
"bankAccountTypeID": 1,
"bankName": "Bank Name",
"bankProcessingType": "PPD",
"contactID": 283482,
"creditCardType": 1,
"customerAccountStatusID": 1,
"customerAccountTypeID": 1,
"customerID": 1234,
"endDate": "2017-09-09T17:35:09.156Z",
"ePayAccountID": 283482,
"ePayNotificationOptOut": true,
"expirationDate": "2017-09-09T17:35:09.156Z",
"expirationNotificationRequestedDate": "2017-09-09T17:35:09.156Z",
"isDeleted": false,
"isTerminated": true,
"lastModifiedDate": "2016-09-09T21:35:09.000Z",
"lastModifiedUser": "Kesha",
"recurringEndDate": "2017-09-09T17:35:09.156Z",
"recurringStartDate": "2017-09-09T17:35:09.156Z",
"recurringStatus": "Recurring",
"remittanceTypeID": 1,
"startDate": "2017-09-09T17:35:09.156Z"
}
]
}

Get an E-Pay Account.

Provides the ability retrieve an E-Pay Accounts. [Rev 2.02]

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier for the E-Pay account that will be charged.

header Parameters

Content-Type

required

string

Example: application/json

Responses

Response samples

200
400

Content type

application/json

{"aBARoutingNumber": 251082615,
"bankAccountNumber": 1234,
"bankAccountType": "Checking",
"bankAccountTypeID": 1,
"bankName": "Bank Name",
"bankProcessingType": "PPD",
"contactID": 283482,
"creditCardType": 1,
"customerAccountStatusID": 1,
"customerAccountTypeID": 1,
"customerID": 1234,
"endDate": "2017-09-09T17:35:09.156Z",
"ePayAccountID": 283482,
"ePayNotificationOptOut": true,
"expirationDate": "2017-09-09T17:35:09.156Z",
"expirationNotificationRequestedDate": "2017-09-09T17:35:09.156Z",
"isDeleted": false,
"isTerminated": true,
"lastModifiedDate": "2016-09-09T21:35:09.000Z",
"lastModifiedUser": "Kesha",
"recurringEndDate": "2017-09-09T17:35:09.156Z",
"recurringStartDate": "2017-09-09T17:35:09.156Z",
"recurringStatus": "Recurring",
"remittanceTypeID": 1,
"startDate": "2017-09-09T17:35:09.156Z",
"token": "1234567890"
}

Search for Retryable E-Pay Tranasctions

Provides the ability tp search for E-Pay Transactions that are marked for retry. [Rev 1.20]

Available Fields

The following is a list of fields from Retryable Tranasctions and how they can be used within the search.

Filterable : amount, customerID, description, descriptionID, epayAccountID, epayRemittanceTypeID, epayTransactionID, epayTransactionTypeID, errorCode, errorMessage, isCorporateAccount, isRecurring, lastFailureDate, lastModified, rootEPayTransactionID, transactionType, userID
Sortable : amount, customerID, description, descriptionID, epayAccountID, epayRemittanceTypeID, payTransactionID, epayTransactionTypeID, errorCode, errorMessage, isRecurring, lastFailureDate, lastModified, rootEPayTransactionID, transactionType, userID

Authorizations:

SWT

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.
$skip	integer Example: $skip=10 Number of search results to skip.
$skiptoken	string Example: $skiptoken=2 Indicator to the next set of results. This value is usually supplied on the response from a previous search.
$top	integer Example: $top=1 Number of search results to retrieve. Default value is 100 with the ability to specify up to 500. Any number greater than 500 will still only return 500 records.

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/{environment}/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"closedDisputeAmount": 1.25,
"closedDisputeCount": 1,
"invoiceDate": "2016-09-09T17:35:09.156Z",
"invoiceNumber": 12345,
"openDisputeAmount": 2.73,
"openDisputeCount": 1
}
]
}

E-Pay Transaction

Create E-Pay Transaction

Create an E-Pay transaction but do not immediately charge the account at the payment provider. [Rev 1.20]

Note

The E-Pay account must have a RemittanceType of Bank Account or Credit Card.

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier for the E-Pay account that will be charged.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

amount	number Dollar amount of the transaction.
approvalCode	string Approval code received while processing the transaction.
approvalDate	string Date the transaction was approved.
bankProcessingType	string (BankProcessingType) Enum: "PPD" "TEL" "WEB"
errorCode	integer Numeric error code received while processing the transaction.
errorMessage	string Error message received while processing the transaction.
originatingEpayTransactionID	number Unique identifier of the E-Pay transaction that a credit is to be applied against. Note: This field will be ignored if the TransactionType of the request is not 'Credit'
providerAVSResultCode	string AVS result code received from the payment provider while processing the transaction.
providerResultCode	string Result code received from the payment provider while processing the transaction
providerTransactionID	string Unique identifier used by the payment provider to identify the transaction
	object (PaymentProviderLog)
rootEpayTransactionID	integer ID of original Epay Transaction
retryIndicator	integer Flag indicating whether or not to retry the transaction
processDate	string Date that the payment transaction should be processed on. If no value is specified it will default to the current server date.
transactionDescriptionID	integer Unique identifier of a previously configured description for payment account transactions.
transactionStatus	string (TransactionStatus) Enum: "Approved" "Decline" "DeclinedVoid" "ErrorVoid" "Inprocess" "Sent" "Unknown" "Unprocessed" "UnprocessedOnetime" "Void" "VoidBySystem" Note: TransactionStatus defaults to "Sent" when not explicitly set.
transactionSource	string (TransactionSource) Enum: "None" "Client" "Online"
transactionType	string (TransactionType) Enum: "Credit" "Debit"

Responses

Request samples

Payload

Content type

application/json

{"amount": 10.03,
"approvalCode": "XXXXX",
"approvalDate": "2007-09-14T16:31:25.657Z",
"bankProcessingType": "PPD",
"errorCode": 2,
"errorMessage": "An error occurred",
"originatingEpayTransactionID": 2,
"providerAVSResultCode": "X",
"providerResultCode": "string",
"providerTransactionID": 0,
"paymentProviderLog": {"approvalCode": 123456,
"epayAccountID": 22,
"provider": "Authorize.NetAPI",
"providerTransactionID": "ABC123",
"requestDate": "2007-09-14T16:31:25.657Z",
"requestInformation": "AUTH_CAPTURE",
"responseCode": "Approved",
"responseMessage": "This transaction has been approved.",
"reponseDate": "2007-09-14T16:31:25.657Z",
"responseInformation": "AUTH_CAPTURE",
"requestCode": "AuthorizeOnly",
"extendedInformation": {"value": [{"Key": "string",
"Remove": "false",
"Value": "string"
}
]
}
},
"rootEpayTransactionID": 1,
"retryIndicator": 1,
"processDate": "2007-09-14T16:31:25.657Z",
"transactionDescriptionID": 1,
"transactionStatus": "Approved",
"transactionSource": "None",
"transactionType": "Credit"
}

Response samples

200
400
500

Content type

application/json

{"amount": 10.03,
"approvalCode": 123,
"approvalDate": "2016-09-09T17:35:09.156Z",
"bankProcessingType": "PPD",
"createDate": "2016-09-09T17:35:09.156Z",
"epayAccountID": 42,
"epayTransactionID": 1,
"errorCode": 12,
"errorMessage": "Transaction was declined.",
"originatingEpayTransactionID": 2,
"originatingProviderTransactionID": "123b45",
"rootEpayTransactionID": 12,
"retryIndicator": 1,
"processDate": "2016-09-09T17:35:09.156Z",
"providerAVSResultCode": "777A7",
"providerResultCode": "Accepted",
"providerTransactionID": "123C45",
"transactionDescriptionID": 4,
"transactionSource": "Online",
"transactionStatus": "Sent",
"transactionType": "Credit"
}

Modify E-Pay Transaction

Provides the ability to modify an existing EPay Transaction [Rev 1.20]

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier for the EPay Transaction to modify.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

approvalCode	string Approval code received while processing the transaction.
approvalDate	string Date the transaction was approved.
errorCode	integer Numeric error code received while processing the transaction.
errorMessage	string Error message received while processing the transaction.
originatingEpayTransactionID	integer Unique identifier of the E-Pay transaction that a credit is to be applied against. Note: This field will be ignored if the TransactionType of the request is not 'Credit'
providerAVSResultCode	string AVS result code received from the payment provider while processing the transaction.
providerResultCode	string Result code received from the payment provider while processing the transaction
providerTransactionID	string Unique identifier used by the payment provider to identify the transaction
	object (PaymentProviderLog)
retryIndicator	integer Flag indicating whether or not to retry the transaction
transactionDescriptionID	integer Unique identifier of a previously configured description for payment account transactions.
transactionStatus	string (TransactionStatus) Enum: "Approved" "Decline" "DeclinedVoid" "ErrorVoid" "Inprocess" "Sent" "Unknown" "Unprocessed" "UnprocessedOnetime" "Void" "VoidBySystem" Note: TransactionStatus defaults to "Sent" when not explicitly set.
transactionSource	string (TransactionSource) Enum: "None" "Client" "Online"

Responses

Request samples

Payload

Content type

application/json

{"approvalCode": "XXXXX",
"approvalDate": "2007-09-14T16:31:25.657Z",
"errorCode": 2,
"errorMessage": "An error occurred",
"originatingEpayTransactionID": 123,
"providerAVSResultCode": "X",
"providerResultCode": "string",
"providerTransactionID": 0,
"paymentProviderLog": {"approvalCode": 123456,
"epayAccountID": 22,
"provider": "Authorize.NetAPI",
"providerTransactionID": "ABC123",
"requestDate": "2007-09-14T16:31:25.657Z",
"requestInformation": "AUTH_CAPTURE",
"responseCode": "Approved",
"responseMessage": "This transaction has been approved.",
"reponseDate": "2007-09-14T16:31:25.657Z",
"responseInformation": "AUTH_CAPTURE",
"requestCode": "AuthorizeOnly",
"extendedInformation": {"value": [{"Key": "string",
"Remove": "false",
"Value": "string"
}
]
}
},
"retryIndicator": 1,
"transactionDescriptionID": 1,
"transactionStatus": "Approved",
"transactionSource": "None"
}

Response samples

200
400
500

Content type

application/json

{"amount": 10.03,
"approvalCode": 123,
"approvalDate": "2016-09-09T17:35:09.156Z",
"bankProcessingType": "PPD",
"createDate": "2016-09-09T17:35:09.156Z",
"epayAccountID": 42,
"epayTransactionID": 1,
"errorCode": 12,
"errorMessage": "Transaction was declined.",
"originatingEpayTransactionID": 2,
"originatingProviderTransactionID": "123b45",
"rootEpayTransactionID": 12,
"retryIndicator": 1,
"processDate": "2016-09-09T17:35:09.156Z",
"providerAVSResultCode": "777A7",
"providerResultCode": "Accepted",
"providerTransactionID": "123C45",
"transactionDescriptionID": 4,
"transactionSource": "Online",
"transactionStatus": "Sent",
"transactionType": "Credit"
}

Create Recurring E-Pay Transactions

Create Recurring E-Pay Transactions for a specified Bill Period [Rev 1.23]

Authorizations:

SWT

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

billPeriod required	integer Identifies the bill period to create recurring E-Pay transactions in.
calculationDate	string The date to be used for the 'Date' creation mode. (DateTime) Note: this defaults to the current date
creationMode	string Enum: "All" "Date" Indicates whether to create recurring E-Pay transactions for the entire bill period or for only invoices with a due date or invoice date past a certain date. Note: defaults to `Date`
lockGUID	string GUID that is used to to lock a bill period to the currently running operation. Note: When the bill period has a lockGuid configured, that GUID must be supplied in the request. [Rev 2.04]

Responses

Request samples

Payload

Content type

application/json

{"billPeriod": 1,
"calculationDate": "2/20/2020 12:00:00",
"creationMode": "All",
"lockGUID": "B3F8C315-F6AB-496C-8793-7080B824A9FD"
}

Response samples

200
400
500

Content type

application/json

{"epayTransactionsCreated": 5,
"invoicesProcessed": 10,
"processingComplete": false
}

Void E-Pay Transactions

Update E-Pay transactions that are Declined or in Processing Error, to be Void By System, for a specified Bill Period [Rev 1.23]

Authorizations:

SWT

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

billPeriod

required

integer

Identifies the bill period to void E-Pay transactions in.

Responses

Request samples

Payload

Content type

application/json

{"billPeriod": 1
}

Response samples

200
400
500

Content type

application/json

{"epayTransactionsVoided": 50,
"processingComplete": false
}

Paymentus

Get Account Balance Summary

Provides the ability to get account balance information needed for Paymentus Integration. [Rev 2.09]

Available Fields

Filterable : accountNumber, customerID, currentBalance, daysPastDue, dueDate, pastDueBalance, totalBalance
Sortable : accountNumber, customerID, currentBalance, daysPastDue, dueDate, pastDueBalance, totalBalance

Authorizations:

SWT

path Parameters

accountNumber

required

number

Example: 1

Unique identifier of the account to retrieve balance summary for.

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"accountNumber": "10018",
"billPaymentTypeCode": "PAYMENT",
"currentBalance": 224.38,
"customerID": 358,
"daysPastDue": 4,
"dueDate": "2022-08-21T00:00:00-04:00",
"email": "null@idi.com",
"firstName": "JOHN",
"isActive": true,
"lastName": "THOMPSON",
"restrictACH": true,
"pastDueBalance": 0,
"paymentTypeGroup": {"paymentTypeGroupID": 1,
"name": "patched",
"description": "patched",
"hasServiceFee": true,
"isDefault": false,
"paymentTypeCodes": [{"paymentTypeCodeID": 4,
"code": "NewCode",
"ptcTypeID": 1,
"ptcType": "Bill Payment"
}
]
},
"totalBalance": 224.38
}
]
}

Create AdvancePay Payment Method

Creates a new AdvancePay Payment Method [Rev 2.18]

Authorizations:

SWT

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

customerID required	number The unique identifier for the customer
expirationDate	string The date the payment method expires. Note: Required if the payment type is a credit card. Optional for all other payment types. [Rev 2.20]
paymentusToken required	string The unique identifier for the payment method
paymentType required	string The type for the payment method
serviceID required	number The unique identifier for the service

Responses

Request samples

Payload

Content type

application/json

{"customerID": 222,
"expirationDate": "2025-12-31",
"paymentusToken": "FFC39FA97FB097825D7EB76873C7FD676563E927",
"paymentType": "VISA",
"serviceID": 1
}

Response samples

200
500

Content type

application/json

{"value": [{"advancePayMethodID": 2,
"customerID": 25014,
"experationDate": "2025-12-31T05:00:00.000Z",
"lastModifiedDate": "2023-07-05T18:56:52.472Z",
"paymentusToken": "FFC39FA97FB097825D7EB76873C7FD676563E927",
"paymentType": "VISA",
"serviceID": 1373541
}
]
}

List Customer AdvancePay Payment Methods

Returns a list of which services are set up for AdvancePay and the payment method associated. [Rev 2.18]

Authorizations:

SWT

path Parameters

id

required

integer

Example: 1

Unique identifier of the customer to access the associated payment methods.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"advancePayMethods": [{"advancePayMethodID": 2,
"experationDate": "2025-12-31T05:00:00.000Z",
"lastModifiedDate": "2023-07-05T18:56:52.472Z",
"paymentusToken": "FFC39FA97FB097825D7EB76873C7FD676563E927",
"paymentType": "VISA",
"serviceID": 1373541
}
],
"customerID": 25014
}

Update AdvancePay Payment Method

Provides the ability to update an AdvancePay Payment Method. [Rev 2.18]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

paymentusToken : replace
expirationDate : replace
paymentType : replace

Authorizations:

SWT

path Parameters

id

required

integer

Example: 1

Unique identifier of the AdvancePay Payment Method to update.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

Array

op required	string Indicates what type of JSON Patch operation being requested. Valid values are `add`, `replace`, and `remove`.
path required	string Path within the JSON document that should be modified.
value	string If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Payload

Content type

application/json

[{"op": "replace",
"path": "/paymentusToken",
"value": "newToken"
}
]

Response samples

400

Content type

application/json

{"errors": [{"field": "ID",
"loggingNumber": 500032,
"message": "You do not have access to AdvancePayMethod ID 1 or it does not exist."
}
]
}

Get Payment Type Code Types

Provides the ability to get the available types for payment Type Codes. [Rev 2.16]

Available Fields

Filterable : PTCTypeID, Description
Sortable : PTCTypeID, Description

Authorizations:

SWT

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"description": "Bill Payment",
"ptcTypeID": 199
}
]
}

Get Payment Type Codes

Provides the ability to get the payment type codes. [Rev 2.16]

Available Fields

Filterable : Code, PaymentTypeCodeID, PaymentTypeGroupID, PTCTypeID, PTCType
Sortable : Code, PaymentTypeCodeID, PaymentTypeGroupID, PTCTypeID, PTCType

Authorizations:

SWT

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"paymentTypeCodeID": 1,
"paymentTypeGroupID": 1,
"code": "PAYMENT",
"ptcTypeID": 1,
"ptcType": "Bill Payment"
}
]
}

Create Payment Type Code

Creates a new Payment Type Code object [Rev 2.16]

Authorizations:

SWT

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

code required	string The Payment Type Code that would be used within the paymentus flow
paymentTypeGroupID required	number The identifier of the payment type group for this payment type code
ptcTypeID required	number The identifier for the related payment type code type.

Responses

Request samples

Payload

Content type

application/json

{"code": "Something",
"paymentTypeGroupID": "1",
"ptcTypeID": 2
}

Response samples

200
500

Content type

application/json

{"value": [{"code": "something",
"paymentTypeCodeID": 2,
"paymentTypeGroupID": 1,
"ptcTypeID": 1
}
]
}

Update Payment Type Code

Provides the ability to update a payment type code. [Rev 2.16]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

code : replace
ptcTypeID : replace
paymentTypeGroupID : replace

Authorizations:

SWT

path Parameters

id

required

integer

Example: 1

Unique identifier of the payment type code to update.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

Array

op required	string Indicates what type of JSON Patch operation being requested. Valid values are `add`, `replace`, and `remove`.
path required	string Path within the JSON document that should be modified.
value	string If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Payload

Content type

application/json

[{"op": "replace",
"path": "/code",
"value": "newCode"
}
]

Response samples

400

Content type

application/json

{"errors": [{"field": "ID",
"loggingNumber": 500032,
"message": "You do not have access to PaymentTypeCode ID 1 or it does not exist."
}
]
}

Delete Payment Type Code

Provides the ability to delete a payment type code. [Rev 2.16]

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier for the Payment Type Code to delete.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

404

Content type

application/json

{"errors": [{"correlationId": "8c041095",
"field": "exampleField",
"loggingNumber": 500032,
"message": "You do not have access to foo ID 1 or it does not exist."
}
]
}

Get Payment Type Groups

Provides the ability to get the payment type groups. [Rev 2.16]

Available Fields

Filterable : PaymentTypeGroupID, Name, IsDefault, HasServiceFee
Sortable : PaymentTypeGroupID, Name, IsDefault, HasServiceFee

Authorizations:

SWT

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"description": "the standard PTG",
"hasServiceFee": true,
"isDefault": true,
"name": "Default PTG",
"paymentTypeGroupID": 1
}
]
}

Create Payment Type Group

Creates a new Payment Type Group object [Rev 2.16]

Authorizations:

SWT

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

hasServiceFee	boolean A bit denoting if the group supports service fees
description	string Informative text for the payment type group.
isDefault	boolean A bit denoting if the group is the default
name required	string The name for the payment type group.

Responses

Request samples

Payload

Content type

application/json

{"hasServiceFee": true,
"description": "This is a default PTG",
"isDefault": true,
"name": "Default PTG"
}

Response samples

200
500

Content type

application/json

{"value": [{"description": "the standard PTG",
"hasServiceFee": true,
"isDefault": true,
"name": "Default PTG",
"paymentTypeGroupID": 1
}
]
}

Get Payment Type Group

Provides the ability to get a payment type group and the associated codes and finance groups. [Rev 2.16]

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier for the Payment Type Group to retrieve.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

[{"description": "the standard PTG",
"financeGroups": {"description": "Group1",
"financeGroupID": 1
},
"hasServiceFee": true,
"isDefault": true,
"name": "Default PTG",
"paymentTypeCodes": {"code": "PAYMENT",
"paymentTypeCodeID": 1,
"ptcTypeID": 1,
"ptcType": "Bill Payment"
},
"paymentTypeGroupID": 1
}
]

Update Payment Type Group

Provides the ability to update a payment type group. [Rev 2.16]

This operation uses the JSON Patch document structure for defining updates to the objects. Read more about JSON Patch (RFC 6902) here.

Patchable Fields

The following is a list of properties that can be patched.

name : replace
description : replace
hasServiceFee : replace
addFinanceGroupID/#array : add
removeFinanceGroupID/#array : add

Authorizations:

SWT

path Parameters

id

required

integer

Example: 1

Unique identifier of the payment type group to update.

header Parameters

Content-Type

required

string

Example: application/json

Request Body schema: application/json

Array

op required	string Indicates what type of JSON Patch operation being requested. Valid values are `add`, `replace`, and `remove`.
path required	string Path within the JSON document that should be modified.
value	string If supplied, the new value to be used at the given path by the given operation.

Responses

Request samples

Payload

Content type

application/json

[{"op": "replace",
"path": "/name",
"value": "newName"
}
]

Response samples

400

Content type

application/json

{"errors": [{"field": "ID",
"loggingNumber": 500032,
"message": "You do not have access to PaymentTypeGroup ID 1 or it does not exist."
}
]
}

Delete Payment Type Group

Provides the ability to delete a payment type group and the associated codes and the linking to the finance group. Note: The default PaymentTypeGroup can't be deleted. [Rev 2.16]

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier for the Payment Type Group to delete.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

404

Content type

application/json

{"errors": [{"correlationId": "8c041095",
"field": "exampleField",
"loggingNumber": 500032,
"message": "You do not have access to foo ID 1 or it does not exist."
}
]
}

Get Active Schedule

Provides the ability to get information about the active Paymentus Schedule for a customer. [Rev 2.16]

Authorizations:

SWT

path Parameters

id

required

number

Example: 1

Unique identifier for the customer.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"accountNumber": "199",
"customerID": 199,
"isActive": true,
"paymentusReferenceNumber": "9894",
"paymentAmount": 112.25,
"paymentAdditionalAmount": 1.25,
"scheduleType": "monthly",
"scheduleDay": 8,
"paymentMethod": "AMEX",
"expiryDate": "2007-09-14T12:31:25.657-04:00"
}

Get Paymentus Schedules

Provides the ability to get information about Paymentus Schedules. [Rev 2.15]

Available Fields

Filterable : accountNumber, customerID, ExpiryDate, IsActive, PaymentusReferenceNumber, PaymentMethod, PaymentAdditionalAmount, PaymentAmount, ScheduleDay, ScheduleType
Sortable : accountNumber, customerID, ExpiryDate, IsActive, PaymentusReferenceNumber, PaymentMethod, PaymentAdditionalAmount, PaymentAmount, ScheduleDay, ScheduleType

Authorizations:

SWT

query Parameters

$count	boolean Example: $count=true Specifies whether to fetch the total count of results. This is the count of all entities that match the `search` and `$filter` parameters, ignoring `$top` and `$skip`. Setting this value to `true` may have a performance impact. Note that the count returned is an approximation.
$filter	string Example: $filter=field1 eq 1234 A structured search expression in standard OData syntax.
$orderby	string Example: $orderby=field1 A list of comma-separated expressions to sort the results by. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order.
$select	string Example: $select=field1, field2 A list of comma-separated fields to retrieve. If unspecified, all fields in the schema are included.

header Parameters

contentType

required

string

Example: application/json

Responses

Response samples

200
404

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"accountNumber": "199",
"customerID": 199,
"isActive": true,
"paymentusReferenceNumber": "9894",
"paymentAmount": 112.25,
"paymentAdditionalAmount": 1.25,
"scheduleType": "monthly",
"scheduleDay": 8,
"paymentMethod": "AMEX",
"expiryDate": "2007-09-14T12:31:25.657-04:00"
}
]
}

Device Callback

Logs the callbacks made by Paymentus while using a terminal device. [Rev 2.30]

Authorizations:

SWT

path Parameters

environment

required

string

Example: AUT_ORD_STAGE

Name of the environment for which this callback should be logged.

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

paymentAmount	string The amount of the payment.
paymentDate	string The date the payment was made.
paymentReferenceNumber	number The unique identifier of the transaction within Paymentus.
paymentStatus	string The status of the transaction.
paymentStatusDescription	string The description of the status of the payment.
	object (POSDetail)
totalCharged	string The total amount charged.

Responses

Request samples

Payload

Content type

application/json

{"paymentAmount": "4.00",
"paymentDate": "04242024145335",
"paymentReferenceNumber": 0,
"paymentStatus": "ACCEPTED",
"paymentStatusDescription": "APPROVED",
"posDetail": {"account": "************5949",
"authCode": "PPS756",
"cardBrand": "VISA",
"cardExpiration": {"dateStr": "10012024",
"dateTimeStr": "10012024000000",
"month": "10",
"timeStr": "000000",
"year": "2024"
},
"cardType": "credit",
"emvApplicationID": "A0000000031010",
"emvApplicationName": "VISA CREDIT",
"emvApplicationResponseCode": "00",
"emvCardEntryMode": "contactless_quick_chip",
"emvCardHolderVerification": "1F0301",
"emvIssuerApplicationData": "06011203A00000",
"emvTerminalVerificationResults": "0000000000",
"errorCode": "000",
"holderName": "CARDHOLDER/VISA",
"isEMVTransaction": true,
"paymentAmount": 4,
"paymentMethodToken": "e39688bc-5c1a-4438-8f1c-7505c5744dc8",
"transactionID": "71bd07b9-b0f0-404d-bcd2-1585958a25a4"
},
"totalCharged": 4
}

Response samples

200
500

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"paymentusTransactionID": 1
}
]
}

Schedule Notification

Stores and updates information around payment scheudles related to Paymentus payment schedules [Rev 1.23]

Authorizations:

SWT

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

accountNumber required	string The identifier for the account the schedule notification relates to.
additionalAmount	number The additional amount added onto the payment schedule
	object (PaymentusCustomer)
paymentAmount required	number The amount paid for payment schedule
	object (PaymentusPaymentMethod)
paymentTypeCode	string the Payment Type Code relating to the payment made for the scheduled payment
requestType required	string Operation to be performed on the account Note Accepted values are: c - Create d - Deactivate u - Update
scheduleDay required	number The day within the context of the schedule type the payment is made
scheduleType required	string The frequency type of the recurring payment
timeStamp	string The time that the action was taken within Paymentus
referenceNumber required	number The unique identifier of the schedule within Paymentus

Responses

Request samples

Payload

Content type

application/json

{"accountNumber": "22",
"additionalAmount": 1.25,
"customer": {"firstName": "Lando",
"lastName": "Norris"
},
"paymentAmount": 112.25,
"paymentMethod": {"accountHolderName": "Lando Norris",
"bankAccountNumber": 4837,
"bankName": "Chase",
"expiryDate": "2007-09-14T16:31:25.657Z",
"routingNumber": 12345678,
"type": "AMEX",
"cardNumber": 6498
},
"paymentTypeCode": "PHONE",
"requestType": "c",
"scheduleDay": 8,
"scheduleType": "monthly",
"timeStamp": "2007-09-14T16:31:25.657Z",
"referenceNumber": 7894
}

Response samples

200
500

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"accountNumber": 2,
"customerID": 2100,
"paymentusScheduleID": 1
}
]
}

Transaction Log

Stores the information for logging calls made to Paymentus. [Rev 2.29]

Authorizations:

SWT

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

accountNumber required	string Identifies the account related to the API call.
amount	number Transaction amount related to the API call.
apiUrl	string URL of the API that was called.
costGuardReferenceNumber	number An identifier for a related record in CostGuard
parentReferenceNumber	number The unique identifier of previously created related transaction within Paymentus
paymentTypeCode	string Payment Type Code related to the API call.
rawRequest	string Serialized string of the API request.
rawResponse	string Serialized string of the API response.
referenceNumber	number The unique identifier of the transaction within Paymentus.
requestSSOToken	string Encrypted SSO token used for the API call.
serviceFeeAmount	number The amount of the service fee related to the API call.
status	string Status returned from the API call.

Responses

Request samples

Payload

Content type

application/json

{"accountNumber": "22",
"amount": 201.25,
"apiUrl": "my.api.somewhere.com",
"costGuardReferenceNumber": 1337,
"parentReferenceNumber": 123,
"paymentTypeCode": "PHONE",
"rawRequest": "A very long string of the serialized API request...",
"rawResponse": "A very long string of the serialized API response...",
"referenceNumber": 7894,
"requestSSOToken": "AQIC5wM2LY4Sfcwbdp3gWuB38NA26klnTJlLPknN8t0fPVY=",
"serviceFeeAmount": 1.25,
"status": "ACCEPTED"
}

Response samples

200
500

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"accountNumber": 2,
"customerID": 2100,
"paymentusTransactionID": 1
}
]
}

Transaction Notification

Stores the information about a transaction made through Paymentus. [Rev 2.11]

Authorizations:

SWT

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

accountNumber required	string The identifier of the account the transaction relates to.
amount required	number The amount of the transaction made.
costGuardReferenceNumber	number An identifier for a related record in CostGuard
	object (PaymentusCustomer)
parentReferenceNumber	number The unique identifier of previously created related transaction within Paymentus
paymentDate required	string the date relating to when the transaction was made
	object (PaymentusPaymentMethod)
paymentTypeCode	string the Payment Type Code relating to the payment made for the scheduled payment
referenceNumber required	number The unique identifier of the transaction within Paymentus
serviceFeeAmount	number The amount of the service fee for the transaction made.
status required	string The status of the transaction NOTE The expected values are: ACCEPTED DECLINED FAILED

Responses

Request samples

Payload

Content type

application/json

{"accountNumber": "22",
"amount": 1.25,
"costGuardReferenceNumber": 1337,
"customer": {"firstName": "Lando",
"lastName": "Norris"
},
"parentReferenceNumber": 123,
"paymentDate": "2007-09-14T16:31:25.657Z",
"paymentMethod": {"accountHolderName": "Lando Norris",
"bankAccountNumber": 4837,
"bankName": "Chase",
"expiryDate": "2007-09-14T16:31:25.657Z",
"routingNumber": 12345678,
"type": "AMEX",
"cardNumber": 6498
},
"paymentTypeCode": "PHONE",
"referenceNumber": 7894,
"serviceFeeAmount": 1.25,
"status": "ACCEPTED"
}

Response samples

200
500

Content type

application/json

{"@odata.count": 145,
"@odata.nextLink": "https://api.idibilling.com/Balance/2X/anenvironment/api/odataquery?$filter=name eq 'foo'&$skip=50",
"value": [{"accountNumber": 2,
"customerID": 2100,
"paymentusTransactionID": 1
}
]
}

Decrypt a Paymentus SSO Token

Decrypts a Paymentus SSO Token

Authorizations:

SWT

header Parameters

contentType

required

string

Example: application/json

Request Body schema: application/json

ssoToken required	string The sso token to be decrypted.
secret required	string The secret the token was encrypted with.

Responses

Request samples

Payload

Content type

application/json

{"ssoToken": "1D3557B3B1E508C6988D09B93C2CC01CAF11B3930847975D9410377649CD2E2A169FC31BC1A887F6E633A53FED5EC6EAB73778C1485E4C806EC17C303004AD021FFAA324C964F29A0E86033FD1896FB1168193A5AA4C130F3DFC56F194F25873330FC7945FA5934E8F005B482AF2A9774F2313C6321C5E54A6BDC1130F9ED38C8F26F9F712DE5311E620BDD7A9ACAEB7B28BBC58D0DF86EDF675AFAF443D075B67FB9FC4950978B8B49E3A50CC800943A871A000D42C69E16DE1EFCFFBA0D9DC8C7FAF3F57F0ADF042F56811587C9497216EB1B8F3A2F17896CDDCF437CBA113E5B7C440B3BB1ED917A719F9ECCA2430811488B155D78CA0C57FC32F23D4897D6F74477F1979A100929C10F6EE2FA7C64657234E9C435201CA3E37A30CC07C9D",
"secret": "9D14F550EABE7E601C680A3153B3Z0A7"
}

Response samples

200
500

Content type

application/json

{"value": [{"ssoToken": "loginId=1;firstName=John;lastName=Doe;email=test@idibilling.com;address.zipCode=941143127;timestamp=1701102347299;iframe=true;ignoreCase=false;dayPhone=1111111111;accounts=[{\"accountNumber\":\"1\",\"paymentTypeCode\":\"PHONE\",\"amountDue\":0.0000,\"paymentAmount\":0.0000}];"
}
]
}

Release Notes

Release Notes 2.39

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.38

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.37

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.36

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.35

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.34

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.33

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.32

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.31

Added path parameter environment to Device Callback [POST] /api/paymentus/deviceCallback/{environment}

Release Notes 2.30

Added Device Callback [POST] /api/paymentus/deviceCallback

Release Notes 2.29

Added Transaction Log [POST] /api/paymentus/transactionLog

Release Notes 2.28

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.27

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.26

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.25

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.24

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.23

Added Decrypt SSO Token [POST] /api/paymentus/decryptSSOToken

Release Notes 2.22

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.21

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.20

Updated request and response body to make ExpirationDate optional for the following.
- Create AdvancePay Payment Method [POST] /api/paymentus/advancePayMethod
- List Customer AdvancePay Payment Methods [GET] /api/paymentus/advancePayMethod/{id}

Release Notes 2.19

Added Search For Invoice Paperless Billing Detail [GET] /api/invoice/paperlessBillingDetail

Release Notes 2.18

Added Create AdvancePay Payment Method [POST] /api/paymentus/advancePayMethod
Added Update AdvancePay Payment Method [PATCH] /api/paymentus/advancePayMethod/{id}
Added List Customer AdvancePay Payment Methods [GET] /api/paymentus/advancePayMethod/{id}
Added Get Paperless Billing Status [GET] /api/customer/{customerId}/paperlessBillingStatus

Release Notes 2.17

Added Get Search For Invoice Tax Details [GET] /api/invoice/{invoiceNumber}/tax
Added totalNewCharges, totalAccountCharges, totalAccountChargesWithAllTaxesIncluded to /api/invoice/{invoiceNumber}/serviceSummaryTotal
Added Get Search For Invoice Charge Summary [GET] /api/invoice/{invoiceNumber}/chargeSummary

Release Notes 2.16

Added Get Payment Type Code Types [GET] /api/paymentus/paymentTypeCodeType
Added Get Payment Type Groups [GET] /api/paymentus/paymentTypegroup
Added Get Payment Type Group [GET] /api/paymentus/paymentTypeGroup/{id}
Added Create Payment Type Group [POST] /api/paymentus/paymentTypeGroup
Added Update Payment Type Group [PATCH] /api/paymentus/paymentTypeGroup/{id}
Added Delete Payment Type Group [DELETE] /api/paymentus/paymentTypeGroup/{id}
Added Create Payment Type Code [POST] /api/paymentus/paymentTypeCode
Added Update Payment Type Code [PATCH] /api/paymentus/paymentTypeCode/{id}
Added Delete Payment Type Code [DELETE] /api/paymentus/paymentTypeCode/{id}
Added Get Payment Type Codes [GET] /api/paymentus/paymentTypeCode
Added PaymentTypeGroup to /api/paymentus/accountBalanceSummary({accountNumber})
Added Get Active Schedule [GET] api/paymentus/schedule/{id}/active

Release Notes 2.15

Added new Paymentus response object(ScheduleNotificationResponse) to /api/paymentus/scheduleNotification
Added new Paymentus response object(TransactionNotificationResponse) to /api/paymentus/transactionNotification
Added Get Paymentus Schedules [GET] /api/paymentus/schedules

Release Notes 2.14

Added isActive, restrictACH to /api/paymentus/accountBalanceSummary({accountNumber})

Release Notes 2.13

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.12

Added CostGuardReferenceNumber to /api/paymentus/transactionNotification

Release Notes 2.11

Added ScheduleNotification /api/paymentus/scheduleNotification
Added transactionNotification /api/paymentus/transactionNotification

Release Notes 2.10

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.09

Added AccountBalanceSummary /api/paymentus/accountBalanceSummary({accountNumber})

Release Notes 2.08

Added InvoiceNumber to /api/customer/{customerID}/openBalance
Added OverflowBalance to /api/customer/{customerID}/accountBalanceByInvoiceCategory

Release Notes 2.07

Added /api/accountTransaction/{accountTransactionID}/summaryByInvoiceCategory
Added /api/invoiceCategory
Added /api/customer/{customerID}/openBalance
Added /api/customer/{customerID}/accountBalanceByInvoiceCategory
Added /api/invoice/{invoiceNumber}/chargesByInvoiceCategory

Release Notes 2.06

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.05

Added ContractPenaltyCharges and InstallmentPlanCharges to /api/invoice/{invoiceNumber}/serviceSummaryCharge
Added ContractPenaltyCharges and InstallmentPlanCharges to BaseCharge and CompareCharge in /api/invoice/{baseInvoiceNumber}/compare/{compareInvoiceNumber}/serviceSummaryCharge

Release Notes 2.04

Added usageExcluded to /api/invoice/{invoiceNumber}/serviceSummaryTotal
Added lockGuid to [POST] /api/epayTransaction/generateRecurring request
Added lockExpiration and lockGuid and to [POST] /api/epayTransaction/generateRecurring response

Release Notes 2.03

Internal changes were applied to this release. There were no external API changes.

Release Notes 2.02

Added /api/epayaccount(epayAcccountID)

Release Notes 2.01

Added /api/invoice/{invoiceNumber}/serviceSummaryTotal
Added /api/invoice/{invoiceNumber}/serviceSummaryCharge
Added /api/invoice/{baseInvoiceNumber}/compare/{compareInvoiceNumber}/serviceSummaryCharge

Release Notes 2.00

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.32

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.31

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.28

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.27

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.26

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.25

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.24

Added totalAdjustments, totalChargeAdjustments, and totalCreditAdjustments to /api/invoice/corporate/{billPeriodID}/{customerID}

Release Notes 1.23

Added /api/epayTransaction/generateRecurring
Added /api/epayTransaction/void

Release Notes 1.22

Added /api/epayAccount.

Release Notes 1.21

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.20

Added /api/retryableTransactions.
Added /api/epayAccount/{id}/epayTransaction .
Added /api/epayTransaction/{id}/epayTransaction .

Release Notes 1.19

Added api/invoice/{invoiceNumber}/accountTransaction .

Release Notes 1.18

Added myTotalChargeExclusive to /api/invoice/corporate/{billPeriodID}/{customerID} .

Release Notes 1.17

Added the ability to look up and E-Pay account by token. POST /api/epayAccountLookup

Release Notes 1.16

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.15

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.14

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.13

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.12

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.11

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.10

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.09

Added the ability to dispute in-advance charges when disputing features. #operation/CreateDispute POST /api/customer/{id}/dispute
Added #operation/SearchForCorporateAccountInvoices" GET /api/invoice/corporate/{billPeriodID}/{customerID} to provide the ability to search for invoice information for a corporate account hierarchy.

Release Notes 1.08

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.07

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.06

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.05

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.04

Added GET /api/customer/{id}/dispute operation
Added POST /api/customer/{id}/dispute operation
Added GET /api/customer/{id}/dispute/summary operation
Added PATCH /api/customer/{id}/dispute/{disputeId} operation
Added POST /api/customer/{id}/dispute/{disputeId}/addFee operation
Added POST /api/customer/{id}/dispute/{disputeId}/adjust operation
Added POST /api/customer/{id}/dispute/{disputeId}/close operation
Added POST /api/customer/{id}/dispute/{disputeId}/reopen operation
Added POST /api/customer/{id}/dispute/{disputeId}/reverse operation
Added GET /api/disputeResolution operation

Release Notes 1.03

Added GET api/invoice
POST /api/epayaccount({id})/chargeaccount - Added ability to link to a previous transaction when issuing a credit.

Release Notes 1.02

Internal changes were applied to this release. There were no external API changes.

Release Notes 1.01

Internal changes were applied to this release. There were no external API changes.